This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.
This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.
| The list of the themes | Global methods by category | Global methods by name | The list of the classes | The list of the controls |
class Window | ||||
| class, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
Extends Realbasic's Window Class. | ||||
CanLiveResize as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window allows live resizing. | ||||
|
Example:
mainwindow.CanLiveResize=true | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. | ||||
collapseable as boolean | ||||
| property, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: returns allways false | ||
|
Function:
Returns true if this window can be collapsed. | ||||
|
Notes:
Collapseable windows are the normal document windows. You can't collapse dialogs or floating windows well. | ||||
CollapseAllWindows(collapse as boolean) | ||||
| method, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing | ||
|
Function:
Collapse all windows. | ||||
|
Example:
CollapseAllWindows true | ||||
|
Notes:
Like pressing alt while you click on the collapse button with the mouth. | ||||
collapsed as boolean | ||||
| property, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: returns allways false | ||
|
Function:
Returns true if this window is collapsed. You can set it. | ||||
|
Example:
mainwindow.collapsed=false 'show window | ||||
|
Notes:
Collapseable windows are the normal document windows. You can't collapse dialogs or floating windows well. | ||||
Hasborder as boolean | ||||
| property, Window | So, 23. Jun 2002 | |||
| Mac OS Classic: Does nothing. | Mac OS Carbon: Does nothing. | Windows: Works. | ||
|
Function:
Decides on Windows if the window has a border. | ||||
|
Example:
mainwindow.Hasborder=false ' Remove border | ||||
HasCloseBox as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window has a CloseBox. | ||||
|
Example:
mainwindow.closebox=false 'remove closebox | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. | ||||
HasCollapseBox as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window has a Collapsebox. | ||||
|
Example:
mainwindow.HasCollapseBox=false 'remove Collapsebox | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. | ||||
HasHorizontalZoomButton as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window can be resized horizontally. | ||||
|
Example:
mainwindow.HasHorizontalZoomButton=false 'remove resizebox mainwindow.HasVerticalZoomButton=false | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. | ||||
HasMaximizeBox as boolean | ||||
| property, Window | So, 2. Jun 2002 | |||
| Mac OS Classic: -> false. | Mac OS Carbon: -> false. | Windows: Works. | ||
|
Function:
Returns true if this window has a Maximize Button. | ||||
|
Example:
mainwindow.HasMaximizeBox=false 'remove Maximize button | ||||
|
Notes:
The window is not redrawn after this so do this in the open event before the user sees the window. | ||||
HasMinimizeBox as boolean | ||||
| property, Window | So, 2. Jun 2002 | |||
| Mac OS Classic: -> false. | Mac OS Carbon: -> false. | Windows: Works. | ||
|
Function:
Returns true if this window has a Minimize Button. | ||||
|
Example:
mainwindow.HasMinimizeBox=false 'remove Minimize button | ||||
|
Notes:
The window is not redrawn after this so do this in the open event before the user sees the window. | ||||
HasNoShadow as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window has no shadow. | ||||
|
Example:
mainwindow.HasNoShadow=true 'remove shadow | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. There seems to be a problem in getting the current state. Seems to return allways false!? | ||||
HasSideTitlebar as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window has the title bar on the side. | ||||
|
Example:
mainwindow.HasSideTitlebar=true 'moves titlebar to side | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. Only good for floating windows. | ||||
HasToolbarButton as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window has a toolbar button. | ||||
|
Example:
mainwindow.HasToolbarButton=true 'shows Toolbar Button | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. The Button is showed on next redraw of the window frame. | ||||
HasVerticalZoomButton as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window can be resized vertically. | ||||
|
Example:
mainwindow.HasHorizontalZoomButton=false 'remove resizebox mainwindow.HasVerticalZoomButton=false | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. | ||||
InWindowMenu as boolean | ||||
| property, Window | Sa, 27. Jul 2002 | |||
| Mac OS Classic: -> false. | Mac OS Carbon: Works. | Windows: -> false. | ||
|
Function:
Decides whether the window is inside the Window menu. | ||||
|
Example:
mainwindow.InWindowMenu=false 'remove from window menu | ||||
IsIconic as boolean | ||||
| property, Window | So, 2. Jun 2002 | |||
| Mac OS Classic: -> false. | Mac OS Carbon: -> false. | Windows: Works. | ||
|
Function:
Returns true if this window is inside the taskbar. | ||||
|
Notes:
If you set IsIconic to true the window is minimized and if you set it to false the window size and position is restored. | ||||
IsResizeable as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Read only. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Returns true if this window is resizeable. | ||||
|
Example:
mainwindow.IsResizeable=false 'remove growbutton | ||||
|
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon. | ||||
IsZoomed as boolean | ||||
| property, Window | So, 2. Jun 2002 | |||
| Mac OS Classic: -> false. | Mac OS Carbon: -> false. | Windows: Works. | ||
|
Function:
Returns true if this window has been maximized. | ||||
|
Notes:
If you set IsZoomed to true the window is maximized and if you set it to false the window size and position is restored. | ||||
MetalLook as boolean | ||||
| property, Window | Fr, 6. Sep 2002 | |||
| Mac OS Classic: -> false. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
Wether the window has a metal look on Mac OS X 10.2 | ||||
|
Example:
mainwindow.MetalLook=true 'change look to metal | ||||
|
Notes:
Currently RB doesn't work nice with this. You can see this if you move a button inside the window or resize it. As we have discusses with some Apple engineers the problem is that RB set's the brush for the Window background and you can't remove this background. | ||||
Modified as boolean | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> false | ||
|
Function:
You can set or get the value of the modified state. | ||||
|
Example:
mainwindow.modified=true | ||||
|
Notes:
Requires Mac OS 8.5 or newer. | ||||
RemoveWindowProxyIcon | ||||
| method, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | ||
|
Function:
Removes any Proxy Icon from the Window. | ||||
|
Example:
mainwindow.RemoveWindowProxyIcon | ||||
|
Notes:
Requires Mac OS 8.5 or newer. | ||||
SetTransparency(value as integer) as boolean | ||||
| method, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: does nothing. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
Your window can have transparency on Mac OS X. | ||||
|
Example:
if MainWindow.SetTransparency(50) then 'fine else 'error end if | ||||
|
Notes:
Use values between 0 and 100. | ||||
SetWindowProxyIcon(type as string,creator as string) | ||||
| method, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | ||
|
Function:
That's the icon to the window which belongs to the combination of type and creator codes. | ||||
|
Example:
mainwindow.SetWindowProxyIcon("RbBF","RBv2") // Add RB Doc Icon | ||||
|
Notes:
Requires Mac OS 8.5 or newer. | ||||
SmoothResize(width as integer,height as integer) | ||||
| method, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: does nothing. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
Resizes the window smoothly. | ||||
|
Example:
dim w,h as integer // get destination dimension w=val(iwidth.text) h=val(iheight.text) // Resize SmoothResize w,h // Now resize via RB to make it permament. width=w height=h | ||||
|
Notes:
You need to set the new size using REALbasic's Windows properties, too. | ||||
UpdateDockWindow | ||||
| method, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: does nothing. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
if your window is minimized this will update the small picture inside the dock on Mac OS X. | ||||
|
Example:
Mainwindow.UpdateDockWindow | ||||
UpdateNow | ||||
| method, Window | Di, 21. Mai 2002 | |||
| Mac OS Classic: does nothing. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
On Mac OS X all Windows are doublebuffered and the OS updates the screen from time to time. This method forces a screen update. | ||||
|
Example:
Mainwindow.UpdateNow | ||||
|
Notes:
Renamed for compatibility to Realbasic 4.5. This function is only available from the plugin on RB versions before RB 4.5. | ||||
UpdateNowRect(left as integer,top as integer,width as integer,height as integer) | ||||
| method, Window | Di, 21. Mai 2002 | |||
| Mac OS Classic: does nothing. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
On Mac OS X all Windows are doublebuffered and the OS updates the screen from time to time. This method forces a screen update for a part of your window. | ||||
|
Example:
Mainwindow.UpdateNowRect Mainwindow.text.left, Mainwindow.text.top, Mainwindow.text.width, Mainwindow.text.height | ||||
|
Notes:
Renamed for compatibility to Realbasic 4.5. This function is only available from the plugin on RB versions before RB 4.5. | ||||
WindowFrameRect as ScreenRect | ||||
| method, Window | So, 28. Apr 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
The size of the screen area your window uses including the frame. | ||||
|
Example:
msgbox "The frame of the Mainwindow is "+str(Mainwindow.WindowFrameRect.left)+" pixels away from the screen border." | ||||
WindowProxyIconFile as folderitem | ||||
| property, Window | Mi, 1. Mai 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | ||
|
Function:
That's the icon to the window which belongs to the file. | ||||
|
Example:
dim f as folderItem f=getopenFolderItem("special/any") if f<>nil then WindowProxyIconFile=f end if | ||||
|
Notes:
Requires Mac OS 8.5 or newer. | ||||
WinMenuHandle as integer | ||||
| property, Window | Mi, 26. Jun 2002 | |||
| Mac OS Classic: -> 0. | Mac OS Carbon: -> 0. | Windows: Works. | ||
|
Function:
A property to access the handle used for the menu of a Window. | ||||
|
Example:
if menu=0 then menu=WinMenuHandle // read it on the first window else winmenuHandle=menu // set it on the second window end if | ||||
|
Notes:
Used in the example "Menu in every Window" to have a menubar in every window on Windows. But never forget to quit your app after all windows were closed. | ||||
Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.